<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Interrupt Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__usbfs__dev__drv__functions__interrupts.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Interrupt Functions<div class="ingroups"><a class="el" href="group__group__usbfs__dev__drv.html">USBFS        (USB Full-Speed Device)</a> &raquo; <a class="el" href="group__group__usbfs__dev__drv__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The Functions Interrupt functions provide an API to register callbacks for interrupt events provided by the USB block, interrupt handler, and configuration functions. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga19b86416f176a19377937c598f413000"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a> (USBFS_Type *base, uint32_t intrCause, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga19b86416f176a19377937c598f413000"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processes interrupt events generated by the USBFS Device.  <a href="#ga19b86416f176a19377937c598f413000">More...</a><br /></td></tr>
<tr class="separator:ga19b86416f176a19377937c598f413000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab3bad7b7e1dde7206fc6c19383420b38"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#gab3bad7b7e1dde7206fc6c19383420b38">Cy_USBFS_Dev_Drv_GetInterruptCauseHi</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:gab3bad7b7e1dde7206fc6c19383420b38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the mask of bits showing the source of the current triggered interrupt.  <a href="#gab3bad7b7e1dde7206fc6c19383420b38">More...</a><br /></td></tr>
<tr class="separator:gab3bad7b7e1dde7206fc6c19383420b38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33bcd2fa964a934ca62e6a89e5bfc1bc"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga33bcd2fa964a934ca62e6a89e5bfc1bc">Cy_USBFS_Dev_Drv_GetInterruptCauseMed</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:ga33bcd2fa964a934ca62e6a89e5bfc1bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the mask of bits showing the source of the current triggered interrupt.  <a href="#ga33bcd2fa964a934ca62e6a89e5bfc1bc">More...</a><br /></td></tr>
<tr class="separator:ga33bcd2fa964a934ca62e6a89e5bfc1bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga46f82da15e28a6b289ffed61fe1d9f7c"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga46f82da15e28a6b289ffed61fe1d9f7c">Cy_USBFS_Dev_Drv_GetInterruptCauseLo</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:ga46f82da15e28a6b289ffed61fe1d9f7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the mask of bits showing the source of the current triggered interrupt.  <a href="#ga46f82da15e28a6b289ffed61fe1d9f7c">More...</a><br /></td></tr>
<tr class="separator:ga46f82da15e28a6b289ffed61fe1d9f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c82695477a7fd20c0af43a87e271ace"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga3c82695477a7fd20c0af43a87e271ace">Cy_USBFS_Dev_Drv_RegisterServiceCallback</a> (USBFS_Type const *base, <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga87ad7ab050630644b29d452ac9b9491f">cy_en_usb_dev_service_cb_t</a> source, <a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga4a39fc4d08003009f3cb1287f13a854e">cy_cb_usbfs_dev_drv_callback_t</a> callback, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga3c82695477a7fd20c0af43a87e271ace"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a callback function to notify about service events (Bus Reset or Endpoint 0 communication) in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>.  <a href="#ga3c82695477a7fd20c0af43a87e271ace">More...</a><br /></td></tr>
<tr class="separator:ga3c82695477a7fd20c0af43a87e271ace"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0aa6031c260bbbc2ca75c8f4a9795c06"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga0aa6031c260bbbc2ca75c8f4a9795c06">Cy_USBFS_Dev_Drv_RegisterSofCallback</a> (USBFS_Type *base, <a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga4a39fc4d08003009f3cb1287f13a854e">cy_cb_usbfs_dev_drv_callback_t</a> callback, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga0aa6031c260bbbc2ca75c8f4a9795c06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a callback function to notify about an SOF event in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>.  <a href="#ga0aa6031c260bbbc2ca75c8f4a9795c06">More...</a><br /></td></tr>
<tr class="separator:ga0aa6031c260bbbc2ca75c8f4a9795c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8750c5860193d62e7946792467615f4a"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga8750c5860193d62e7946792467615f4a">Cy_USBFS_Dev_Drv_RegisterLpmCallback</a> (USBFS_Type *base, <a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga4a39fc4d08003009f3cb1287f13a854e">cy_cb_usbfs_dev_drv_callback_t</a> callback, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga8750c5860193d62e7946792467615f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a callback function to notify about an LPM event in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>.  <a href="#ga8750c5860193d62e7946792467615f4a">More...</a><br /></td></tr>
<tr class="separator:ga8750c5860193d62e7946792467615f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga639d1ef6c6898e0c0c01321ba286e38d"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga639d1ef6c6898e0c0c01321ba286e38d">Cy_USBFS_Dev_Drv_RegisterEndpointCallback</a> (USBFS_Type const *base, uint32_t endpoint, <a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga8f3d05a8716e5d7b1f208038882c8328">cy_cb_usbfs_dev_drv_ep_callback_t</a> callback, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga639d1ef6c6898e0c0c01321ba286e38d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a callback function to notify of an endpoint transfer completion event in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>.  <a href="#ga639d1ef6c6898e0c0c01321ba286e38d">More...</a><br /></td></tr>
<tr class="separator:ga639d1ef6c6898e0c0c01321ba286e38d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga964eb2887c340ccd5dc33d98ba75fe8f"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga964eb2887c340ccd5dc33d98ba75fe8f">Cy_USBFS_Dev_Drv_SetInterruptsLevel</a> (USBFS_Type *base, uint32_t intrLevel)</td></tr>
<tr class="memdesc:ga964eb2887c340ccd5dc33d98ba75fe8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes INTR_LVL_SEL register which contains groups for all interrupt sources.  <a href="#ga964eb2887c340ccd5dc33d98ba75fe8f">More...</a><br /></td></tr>
<tr class="separator:ga964eb2887c340ccd5dc33d98ba75fe8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1f86a2a679be34ac945ac993d5de0d02"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga1f86a2a679be34ac945ac993d5de0d02">Cy_USBFS_Dev_Drv_GetInterruptsLevel</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:ga1f86a2a679be34ac945ac993d5de0d02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the INTR_LVL_SEL register that contains groups for all interrupt sources.  <a href="#ga1f86a2a679be34ac945ac993d5de0d02">More...</a><br /></td></tr>
<tr class="separator:ga1f86a2a679be34ac945ac993d5de0d02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8bdba333bc39fcbb9b864ed8225d01ca"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga8bdba333bc39fcbb9b864ed8225d01ca">Cy_USBFS_Dev_Drv_DisableEp0Interrupt</a> (USBFS_Type *base)</td></tr>
<tr class="memdesc:ga8bdba333bc39fcbb9b864ed8225d01ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the Control Endpoint 0 interrupt source.  <a href="#ga8bdba333bc39fcbb9b864ed8225d01ca">More...</a><br /></td></tr>
<tr class="separator:ga8bdba333bc39fcbb9b864ed8225d01ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8eb20575b76a653c3f6812a50ad0d8f0"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga8eb20575b76a653c3f6812a50ad0d8f0">Cy_USBFS_Dev_Drv_EnableEp0Interrupt</a> (USBFS_Type *base)</td></tr>
<tr class="memdesc:ga8eb20575b76a653c3f6812a50ad0d8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the Control Endpoint 0 interrupt.  <a href="#ga8eb20575b76a653c3f6812a50ad0d8f0">More...</a><br /></td></tr>
<tr class="separator:ga8eb20575b76a653c3f6812a50ad0d8f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga19b86416f176a19377937c598f413000"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19b86416f176a19377937c598f413000">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Interrupt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_Interrupt </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>intrCause</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Processes interrupt events generated by the USBFS Device. </p>
<p>The interrupts are mandatory for USBFS Device operation and this function must be called inside the user-defined interrupt service routine.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">intrCause</td><td>The interrupt cause register value. Call appropriate function to get interrupt cause (Low, Medium or High):<ul>
<li><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga46f82da15e28a6b289ffed61fe1d9f7c">Cy_USBFS_Dev_Drv_GetInterruptCauseLo</a></li>
<li><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga33bcd2fa964a934ca62e6a89e5bfc1bc">Cy_USBFS_Dev_Drv_GetInterruptCauseMed</a></li>
<li><a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#gab3bad7b7e1dde7206fc6c19383420b38">Cy_USBFS_Dev_Drv_GetInterruptCauseHi</a></li>
</ul>
</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab3bad7b7e1dde7206fc6c19383420b38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab3bad7b7e1dde7206fc6c19383420b38">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_GetInterruptCauseHi()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_GetInterruptCauseHi </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the mask of bits showing the source of the current triggered interrupt. </p>
<p>This is useful for modes of operation where an interrupt can be generated by conditions in multiple interrupt source registers.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mask with the OR of the following conditions that have been triggered. See <a class="el" href="group__group__usbfs__dev__drv__macros__intr__cause.html">Interrupt Cause</a> for the set of constants. </dd></dl>

</div>
</div>
<a id="ga33bcd2fa964a934ca62e6a89e5bfc1bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga33bcd2fa964a934ca62e6a89e5bfc1bc">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_GetInterruptCauseMed()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_GetInterruptCauseMed </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the mask of bits showing the source of the current triggered interrupt. </p>
<p>This is useful for modes of operation where an interrupt can be generated by conditions in multiple interrupt source registers.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mask with the OR of the following conditions that have been triggered. See <a class="el" href="group__group__usbfs__dev__drv__macros__intr__cause.html">Interrupt Cause</a> for the set of constants. </dd></dl>

</div>
</div>
<a id="ga46f82da15e28a6b289ffed61fe1d9f7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga46f82da15e28a6b289ffed61fe1d9f7c">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_GetInterruptCauseLo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_GetInterruptCauseLo </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the mask of bits showing the source of the current triggered interrupt. </p>
<p>This is useful for modes of operation where an interrupt can be generated by conditions in multiple interrupt source registers.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mask with the OR of the following conditions that have been triggered. See <a class="el" href="group__group__usbfs__dev__drv__macros__intr__cause.html">Interrupt Cause</a> for the set of constants. </dd></dl>

</div>
</div>
<a id="ga3c82695477a7fd20c0af43a87e271ace"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c82695477a7fd20c0af43a87e271ace">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_RegisterServiceCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_RegisterServiceCallback </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__enums.html#ga87ad7ab050630644b29d452ac9b9491f">cy_en_usb_dev_service_cb_t</a>&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga4a39fc4d08003009f3cb1287f13a854e">cy_cb_usbfs_dev_drv_callback_t</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a callback function to notify about service events (Bus Reset or Endpoint 0 communication) in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>. </p>
<p>To remove callback function, pass NULL as function pointer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">source</td><td>The event that involves the callback.</td></tr>
    <tr><td class="paramname">callback</td><td>The pointer to a callback function.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The status code of the function execution <a class="el" href="group__group__usbfs__dev__drv__enums.html#gace2573b482baf5a2a0f796b72cc244ac">cy_en_usbfs_dev_drv_status_t</a>. </dd></dl>

</div>
</div>
<a id="ga0aa6031c260bbbc2ca75c8f4a9795c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0aa6031c260bbbc2ca75c8f4a9795c06">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_RegisterSofCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_RegisterSofCallback </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga4a39fc4d08003009f3cb1287f13a854e">cy_cb_usbfs_dev_drv_callback_t</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a callback function to notify about an SOF event in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>. </p>
<p>The SOF interrupt source is enabled after registration. To remove callback function, pass NULL as the function pointer. When the callback is removed, the interrupt source is disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">callback</td><td>The pointer to a callback function.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>To remove the callback, pass NULL as the pointer to a callback function. </dd></dl>

</div>
</div>
<a id="ga8750c5860193d62e7946792467615f4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8750c5860193d62e7946792467615f4a">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_RegisterLpmCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_RegisterLpmCallback </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga4a39fc4d08003009f3cb1287f13a854e">cy_cb_usbfs_dev_drv_callback_t</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a callback function to notify about an LPM event in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>. </p>
<p>The LPM interrupt source is enabled after registration. To remove the callback function, pass NULL as the function pointer. When the callback is removed, the interrupt source is disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">callback</td><td>The pointer to a callback function.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>To remove the callback, pass NULL as the pointer to the callback function. </dd></dl>

</div>
</div>
<a id="ga639d1ef6c6898e0c0c01321ba286e38d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga639d1ef6c6898e0c0c01321ba286e38d">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_RegisterEndpointCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_RegisterEndpointCallback </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>endpoint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__data__structures.html#ga8f3d05a8716e5d7b1f208038882c8328">cy_cb_usbfs_dev_drv_ep_callback_t</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a callback function to notify of an endpoint transfer completion event in <a class="el" href="group__group__usbfs__dev__drv__functions__interrupts.html#ga19b86416f176a19377937c598f413000">Cy_USBFS_Dev_Drv_Interrupt</a>. </p>
<ul>
<li>IN endpoint - The Host read data from the endpoint and new data can be loaded.</li>
<li>OUT endpoint - The Host has written data into the endpoint and the data is ready to be read. To remove the callback function, pass NULL as function pointer.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">endpoint</td><td>The data endpoint number.</td></tr>
    <tr><td class="paramname">callback</td><td>The pointer to a callback function.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>To remove the callback, pass NULL as the pointer to the callback function. </dd></dl>

</div>
</div>
<a id="ga964eb2887c340ccd5dc33d98ba75fe8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga964eb2887c340ccd5dc33d98ba75fe8f">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_SetInterruptsLevel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_SetInterruptsLevel </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>intrLevel</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Writes INTR_LVL_SEL register which contains groups for all interrupt sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">intrLevel</td><td>INTR_LVL_SEL register value. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga1f86a2a679be34ac945ac993d5de0d02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1f86a2a679be34ac945ac993d5de0d02">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_GetInterruptsLevel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_GetInterruptsLevel </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the INTR_LVL_SEL register that contains groups for all interrupt sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the INTR_LVL_SEL register that contains groups for all interrupt sources. </dd></dl>

</div>
</div>
<a id="ga8bdba333bc39fcbb9b864ed8225d01ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8bdba333bc39fcbb9b864ed8225d01ca">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_DisableEp0Interrupt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_DisableEp0Interrupt </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the Control Endpoint 0 interrupt source. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga8eb20575b76a653c3f6812a50ad0d8f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8eb20575b76a653c3f6812a50ad0d8f0">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_EnableEp0Interrupt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_EnableEp0Interrupt </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the Control Endpoint 0 interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance source. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
